Add ChatQnA docker-compose example on AIPC using MariaDB Vector #1902

RazvanLiviuVarzaru · 2025-05-05T08:09:54Z

Description

Add ChatQnA docker-compose example on AIPC using MariaDB Vector.
Depends on: opea-project/GenAIComps#1645

Issues

n/a

Type of change

New feature (non-breaking change which adds new functionality)

Dependencies

n/a

Tests

Set the HF API token environment variable and:

cd ChatQnA/tests
bash test_compose_mariadb_on_aipc.sh

github-actions · 2025-05-05T08:10:09Z

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

Copilot

Pull Request Overview

This PR introduces a docker-compose example for deploying the ChatQnA service on AIPC using MariaDB Vector.

Adds a new compose file (compose_mariadb.yaml) configuring multiple services including MariaDB, dataprep, embedding, retriever, UI, nginx, and ollama.
Provides a README (README_mariadb.md) with detailed instructions and quick-start steps to deploy the service.

Reviewed Changes

Copilot reviewed 2 out of 4 changed files in this pull request and generated 1 comment.

File	Description
ChatQnA/docker_compose/intel/cpu/aipc/compose_mariadb.yaml	New docker-compose configuration that orchestrates several dependent services including the MariaDB container.
ChatQnA/docker_compose/intel/cpu/aipc/README_mariadb.md	Documentation for setting up and deploying the ChatQnA service with MariaDB Vector using docker-compose.

Files not reviewed (2)

ChatQnA/docker_compose/intel/cpu/aipc/set_env_mariadb.sh: Language not supported
ChatQnA/tests/test_compose_mariadb_on_aipc.sh: Language not supported

Comments suppressed due to low confidence (1)

ChatQnA/docker_compose/intel/cpu/aipc/README_mariadb.md:1

[nitpick] Consider updating the README title to reflect that this example uses MariaDB Vector, aligning it with the PR title.

# Build Mega Service of ChatQnA on AIPC

ChatQnA/docker_compose/intel/cpu/aipc/compose_mariadb.yaml

lvliang-intel · 2025-05-07T01:10:35Z

@chensuyue,
Is there any AIPC ready for using in CI system?

chensuyue · 2025-05-07T01:22:25Z

@chensuyue, Is there any AIPC ready for using in CI system?

No, we don't have AIPC for CI.

chensuyue · 2025-05-07T01:43:09Z

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test.
If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

RazvanLiviuVarzaru · 2025-05-07T13:07:41Z

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue

I've added a Xeon example here: #1916.
For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.

As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.

Thanks!

ashahba · 2025-05-07T23:13:05Z

Labeling this as WIP until we are ready for invest resources into AIPC testing.

chensuyue · 2025-05-08T03:57:37Z

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue

I've added a Xeon example here: #1916. For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.

As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.

Thanks!

Once the PR1654 merged, the related images in the dockerhub will be refreshed in one day or two. But in CI test, we always use images build from latest GenAIComps main branch.
Regarding to this PR, you can mark the test with _ as _test_compose_mariadb_on_aipc.sh, so it will not be triggered by CI. And leave a message if you pass the local test and we can merge it first.

Example on how to deploy the ChatBot on AIPC by using MariaDB Server as a vectorstore. - use MariaDB Server as the backend database. Minimum required version is 11.7 - use the OPEA_DATAPREP_MARIADBVECTOR component for dataprep microservice - use the OPEA_RETRIEVER_MARIADBVECTOR component for retriever microservice How to test Set the HF API token environment variable and: ``` cd ChatQnA/tests bash _test_compose_mariadb_on_aipc.sh ``` Signed-off-by: Razvan-Liviu Varzaru <razvan@mariadb.org>

RazvanLiviuVarzaru · 2025-05-08T09:18:09Z

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue
I've added a Xeon example here: #1916. For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.
As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.
Thanks!

Once the PR1654 merged, the related images in the dockerhub will be refreshed in one day or two. But in CI test, we always use images build from latest GenAIComps main branch. Regarding to this PR, you can mark the test with _ as _test_compose_mariadb_on_aipc.sh, so it will not be triggered by CI. And leave a message if you pass the local test and we can merge it first.

@chensuyue Marked the test script file with _.
Tests on my machine were ok, results: https://gist.github.com/RazvanLiviuVarzaru/7dd026dc3ba964bc90331fd45b4c45e7

xiguiw · 2025-05-16T07:39:14Z

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue

I've added a Xeon example here: #1916. For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.

As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.

Thanks!

@RazvanLiviuVarzaru

As there is Xeon version example to adopt "MariaDB Vector".
For the APIC version, there is no resources for CI/CD for AIPC, how about close this PR?

RazvanLiviuVarzaru · 2025-05-16T08:36:52Z

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue
I've added a Xeon example here: #1916. For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.
As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.
Thanks!

@RazvanLiviuVarzaru

As there is Xeon version example to adopt "MariaDB Vector". For the APIC version, there is no resources for CI/CD for AIPC, how about close this PR?

@xiguiw I was hopping that adding _ to avoid triggering the CI + providing my own test results will get this through so users have the chance to test this example on their own laptops / workstations.
If that's not possible, yes, you can close it.

CICD-at-OPEA · 2025-06-15T22:42:05Z

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

CICD-at-OPEA · 2025-06-22T22:42:09Z

This PR was closed because it has been stalled for 7 days with no activity.

Copilot AI review requested due to automatic review settings May 5, 2025 08:09

RazvanLiviuVarzaru requested review from letonghan and lvliang-intel as code owners May 5, 2025 08:09

Copilot AI reviewed May 5, 2025

View reviewed changes

ChatQnA/docker_compose/intel/cpu/aipc/compose_mariadb.yaml Show resolved Hide resolved

lvliang-intel requested a review from chensuyue May 7, 2025 01:15

ashahba added the WIP label May 7, 2025

RazvanLiviuVarzaru force-pushed the feature/mariadb-vector branch from 12371ba to a150312 Compare May 8, 2025 09:12

RazvanLiviuVarzaru force-pushed the feature/mariadb-vector branch from a150312 to 4d61d86 Compare May 8, 2025 09:14

chensuyue approved these changes May 9, 2025

View reviewed changes

CICD-at-OPEA added the Stale label Jun 15, 2025

CICD-at-OPEA closed this Jun 22, 2025

Add ChatQnA docker-compose example on AIPC using MariaDB Vector #1902

Add ChatQnA docker-compose example on AIPC using MariaDB Vector #1902

Uh oh!

Conversation

RazvanLiviuVarzaru commented May 5, 2025

Description

Issues

Type of change

Dependencies

Tests

Uh oh!

github-actions bot commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

lvliang-intel commented May 7, 2025

Uh oh!

chensuyue commented May 7, 2025

Uh oh!

chensuyue commented May 7, 2025

Uh oh!

RazvanLiviuVarzaru commented May 7, 2025

Uh oh!

ashahba commented May 7, 2025

Uh oh!

chensuyue commented May 8, 2025

Uh oh!

RazvanLiviuVarzaru commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xiguiw commented May 16, 2025

Uh oh!

RazvanLiviuVarzaru commented May 16, 2025

Uh oh!

CICD-at-OPEA commented Jun 15, 2025

Uh oh!

CICD-at-OPEA commented Jun 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

github-actions bot commented May 5, 2025 •

edited

Loading

RazvanLiviuVarzaru commented May 8, 2025 •

edited

Loading